Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update README.md #2441

Merged
merged 2 commits into from
Feb 26, 2024
Merged

chore: update README.md #2441

merged 2 commits into from
Feb 26, 2024

Conversation

huijing
Copy link
Contributor

@huijing huijing commented Feb 22, 2024

Changes proposed in this pull request

  • This PR refines the elevator pitch of what Rafiki is.

@github-actions github-actions bot added the type: documentation (archived) Improvements or additions to documentation label Feb 22, 2024
@huijing huijing changed the title Update README.md chore: update README.md Feb 22, 2024
Copy link

netlify bot commented Feb 22, 2024

Deploy Preview for brilliant-pasca-3e80ec ready!

Name Link
🔨 Latest commit 58f128c
🔍 Latest deploy log https://app.netlify.com/sites/brilliant-pasca-3e80ec/deploys/65d73373b9867c00082798a7
😎 Deploy Preview https://deploy-preview-2441--brilliant-pasca-3e80ec.netlify.app/
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

README.md Outdated
@@ -4,7 +4,7 @@

## What is Rafiki?

Rafiki is open source software that allows an [Account Servicing Entity](https://rafiki.dev/concepts/account-servicing-entity/) to enable [Interledger](https://rafiki.dev/concepts/interledger-protocol/overview/) functionality on its users' accounts.
Rafiki is open source software that provides a more efficient method for an [Account Servicing Entity](https://rafiki.dev/concepts/account-servicing-entity/) to enable Interledger functionality on its users' accounts.
Copy link
Contributor

@mkurapov mkurapov Feb 22, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Rafiki is open source software that provides a more efficient method for an [Account Servicing Entity](https://rafiki.dev/concepts/account-servicing-entity/) to enable Interledger functionality on its users' accounts.
Rafiki is open source software that provides an efficient solution for an [Account Servicing Entity](https://rafiki.dev/concepts/account-servicing-entity/) to enable Interledger functionality on its users' accounts.

nit-picky, but "a more" implies some sort of comparison between an alternative which we don't talk about
(we can also make this a slack discussion)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we also update the landing page?

Copy link
Contributor Author

@huijing huijing Feb 22, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good point. both of them. have made the changes in the next commit (also landing page)

@github-actions github-actions bot added the pkg: documentation Changes in the documentation package. label Feb 22, 2024
@@ -4,7 +4,7 @@

## What is Rafiki?

Rafiki is open source software that allows an [Account Servicing Entity](https://rafiki.dev/concepts/account-servicing-entity/) to enable [Interledger](https://rafiki.dev/concepts/interledger-protocol/overview/) functionality on its users' accounts.
Rafiki is open source software that provides an efficient solution for an [Account Servicing Entity](https://rafiki.dev/concepts/account-servicing-entity/) to enable Interledger functionality on its users' accounts.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit-picky, but Account Servicing Entity should be in lowercase.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we need a convention here, I would have argued "Account Servicing Entity" is always capitalized.

@sabineschaller sabineschaller merged commit 6275027 into main Feb 26, 2024
22 checks passed
@sabineschaller sabineschaller deleted the huijing-patch-1 branch February 26, 2024 10:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pkg: documentation Changes in the documentation package. type: documentation (archived) Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants